package com.rill.springbootdemo;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 *swagger配置类：主要是针对请求本身，其描述主要来源于函数的命名，对用户不友好；可以用过@ApiOperation注解来给API增加说明,详见扫描的controller包
 *
 */
@Configuration // 由spring来加载此类
@EnableSwagger2 // 启动swagger2
public class Swagger2 {

	/**
	 * 通过createRestApi函数创建Docket的Bean
	 * 
	 * @return
	 */
	@Bean
	public Docket createRestApi() {
		return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
				.select()   
//				select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现,本例采用指定扫描的包路径来定义，
//				Swagger会扫描该包下所有Controller定义的API，并产生文档内容（除了被@ApiIgnore指定的请求）。
				.apis(RequestHandlerSelectors.basePackage("com.rill.springbootdemo.controller"))
				.paths(PathSelectors.any()).build();
	}

	/**
	 * apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）
	 * @return
	 */
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				.title("Spring Boot中使用Swagger2构建RESTful APIs")
				.description("springboot练习demo:swagger2输出接口文档，便于维护文档，页面调试")
				.termsOfServiceUrl("http://blog.didispace.com/")
				.contact("程序猿DD").version("1.0").build();
	}

}